<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.6.1" />

	<title>Class REST_Controller</title>

	<script type="text/javascript" src="resources/combined.js?144019575"></script>
	<script type="text/javascript" src="elementlist.js?2260620923"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?1532301413" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li class="active"><a href="package-CodeIgniter.html">CodeIgniter<span></span></a>
						<ul>
				<li class="active"><a href="package-CodeIgniter.Libraries.html">Libraries</a>
						</li>
							</ul></li>
				<li><a href="package-None.html">None</a>
						</li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-Acciones.html">Acciones</a></li>
				<li><a href="class-Datatables.html">Datatables</a></li>
				<li class="active"><a href="class-REST_Controller.html">REST_Controller</a></li>
				<li><a href="class-Usuarios.html">Usuarios</a></li>
			</ul>





		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-CodeIgniter.Libraries.html" title="Summary of CodeIgniter\Libraries"><span>Package</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class REST_Controller</h1>


	<div class="description">
	
<p>CodeIgniter Rest Controller</p>

<p>A fully RESTful server implementation for CodeIgniter using one library, one
config file and one controller.</p>

	</div>

	<dl class="tree">
		<dd style="padding-left:0px">
CI_Controller
			
			
		</dd>
		<dd style="padding-left:30px">
			<img src="resources/inherit.png" alt="Extended by" />
<b><span>REST_Controller</span></b>			
			
			
		</dd>
	</dl>


	<div>
		<h4>Direct known subclasses</h4>
			<a href="class-Acciones.html">Acciones</a>, 
			<a href="class-Usuarios.html">Usuarios</a>
	</div>






	<div class="info">
		<b>Abstract</b><br />
		
		
		<b>Package:</b> <a href="package-CodeIgniter.html">CodeIgniter</a>\<a href="package-CodeIgniter.Libraries.html">Libraries</a><br />

				<b>Category:</b>
				Libraries<br />
				<b>License:</b>
				<a href="http://philsturgeon.co.uk/code/dbad-license">http://philsturgeon.co.uk/code/dbad-license</a><br />
				<b>Author:</b>
				Phil Sturgeon<br />
				<b>Version:</b>
				2.6.0<br />
				<b>Link:</b>
				<a href="https://github.com/philsturgeon/codeigniter-restserver">https://github.com/philsturgeon/codeigniter-restserver</a><br />
		<b>Located at</b> <a href="source-class-REST_Controller.html#3" title="Go to source code">libraries/REST_Controller.php</a><br />
	</div>


	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="early_checks" id="_early_checks">

		<td class="attributes"><code>
			 protected 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_early_checks">#</a>
		<code><a href="source-class-REST_Controller.html#120" title="Go to source code">early_checks</a>( )</code>

		<div class="description short">
			
<p>Developers can extend this class and add a check in here.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Developers can extend this class and add a check in here.</p>







		</div>
		</div></td>
	</tr>
	<tr data-order="__construct" id="___construct">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#___construct">#</a>
		<code><a href="source-class-REST_Controller.html#128" title="Go to source code">__construct</a>( )</code>

		<div class="description short">
			
<p>Constructor function</p>

		</div>

		<div class="description detailed hidden">
			
<p>Constructor function</p>







		</div>
		</div></td>
	</tr>
	<tr data-order="_remap" id="__remap">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__remap">#</a>
		<code><a href="source-class-REST_Controller.html#262" title="Go to source code">_remap</a>( <span>string <var>$object_called</var></span>, <span>array <var>$arguments</var></span> )</code>

		<div class="description short">
			
<p>Remap</p>

		</div>

		<div class="description detailed hidden">
			
<p>Remap</p>

<p>Requests are not made to methods directly, the request will be for an
"object". This simply maps the object and method to the correct Controller
method.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$object_called</var></dt>
					<dd><code>string</code></dd>
					<dt><var>$arguments</var></dt>
					<dd><code>array</code><br> The arguments passed to the controller method.</dd>
				</dl></div>




		</div>
		</div></td>
	</tr>
	<tr data-order="response" id="_response">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_response">#</a>
		<code><a href="source-class-REST_Controller.html#340" title="Go to source code">response</a>( <span>array <var>$data</var> = <span class="php-keyword1">array</span>()</span>, <span>null|integer <var>$http_code</var> = <span class="php-keyword1">null</span></span> )</code>

		<div class="description short">
			
<p>Response</p>

		</div>

		<div class="description detailed hidden">
			
<p>Response</p>

<p>Takes pure data and optionally a status code, then creates the response.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$data</var></dt>
					<dd><code>array</code></dd>
					<dt><var>$http_code</var></dt>
					<dd><code>null|integer</code></dd>
				</dl></div>




		</div>
		</div></td>
	</tr>
	<tr data-order="_detect_input_format" id="__detect_input_format">

		<td class="attributes"><code>
			 protected 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__detect_input_format">#</a>
		<code><a href="source-class-REST_Controller.html#423" title="Go to source code">_detect_input_format</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			






		</div>
		</div></td>
	</tr>
	<tr data-order="_detect_output_format" id="__detect_output_format">

		<td class="attributes"><code>
			 protected 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__detect_output_format">#</a>
		<code><a href="source-class-REST_Controller.html#445" title="Go to source code">_detect_output_format</a>( )</code>

		<div class="description short">
			
<p>Detect format</p>

		</div>

		<div class="description detailed hidden">
			
<p>Detect format</p>

<p>Detect which format should be used to output the data.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br>The output format.<br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="_detect_method" id="__detect_method">

		<td class="attributes"><code>
			 protected 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__detect_method">#</a>
		<code><a href="source-class-REST_Controller.html#526" title="Go to source code">_detect_method</a>( )</code>

		<div class="description short">
			
<p>Detect method</p>

		</div>

		<div class="description detailed hidden">
			
<p>Detect method</p>

<p>Detect which method (POST, PUT, GET, DELETE) is being used</p>




				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="_detect_api_key" id="__detect_api_key">

		<td class="attributes"><code>
			 protected 
			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__detect_api_key">#</a>
		<code><a href="source-class-REST_Controller.html#557" title="Go to source code">_detect_api_key</a>( )</code>

		<div class="description short">
			
<p>Detect API Key</p>

		</div>

		<div class="description detailed hidden">
			
<p>Detect API Key</p>

<p>See if the user has provided an API key</p>




				<h4>Returns</h4>
				<div class="list">
					<code>boolean</code><br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="_detect_lang" id="__detect_lang">

		<td class="attributes"><code>
			 protected 
			null|string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__detect_lang">#</a>
		<code><a href="source-class-REST_Controller.html#598" title="Go to source code">_detect_lang</a>( )</code>

		<div class="description short">
			
<p>Detect language(s)</p>

		</div>

		<div class="description detailed hidden">
			
<p>Detect language(s)</p>

<p>What language do they want it in?</p>




				<h4>Returns</h4>
				<div class="list">
					<code>null|string</code><br>The language code.<br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="_log_request" id="__log_request">

		<td class="attributes"><code>
			 protected 
			object
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__log_request">#</a>
		<code><a href="source-class-REST_Controller.html#633" title="Go to source code">_log_request</a>( <span>boolean <var>$authorized</var> = <span class="php-keyword1">FALSE</span></span> )</code>

		<div class="description short">
			
<p>Log request</p>

		</div>

		<div class="description detailed hidden">
			
<p>Log request</p>

<p>Record the entry for awesomeness purposes</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$authorized</var></dt>
					<dd><code>boolean</code></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>object</code><br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="_check_limit" id="__check_limit">

		<td class="attributes"><code>
			 protected 
			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__check_limit">#</a>
		<code><a href="source-class-REST_Controller.html#654" title="Go to source code">_check_limit</a>( <span>string <var>$controller_method</var></span> )</code>

		<div class="description short">
			
<p>Limiting requests</p>

		</div>

		<div class="description detailed hidden">
			
<p>Limiting requests</p>

<p>Check if the requests are coming in a tad too fast.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$controller_method</var></dt>
					<dd><code>string</code><br> The method deing called.</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>boolean</code><br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="_auth_override_check" id="__auth_override_check">

		<td class="attributes"><code>
			 protected 
			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__auth_override_check">#</a>
		<code><a href="source-class-REST_Controller.html#712" title="Go to source code">_auth_override_check</a>( )</code>

		<div class="description short">
			
<p>Auth override check</p>

		</div>

		<div class="description detailed hidden">
			
<p>Auth override check</p>

<p>Check if there is a specific auth type set for the current class/method being
called.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>boolean</code><br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="get" id="_get">

		<td class="attributes"><code>
			 public 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_get">#</a>
		<code><a href="source-class-REST_Controller.html#772" title="Go to source code">get</a>( <span>string <var>$key</var> = <span class="php-keyword1">NULL</span></span>, <span>boolean <var>$xss_clean</var> = <span class="php-keyword1">TRUE</span></span> )</code>

		<div class="description short">
			
<p>Retrieve a value from the GET request arguments.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Retrieve a value from the GET request arguments.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$key</var></dt>
					<dd><code>string</code><br> The key for the GET request argument to retrieve</dd>
					<dt><var>$xss_clean</var></dt>
					<dd><code>boolean</code><br> Whether the value should be XSS cleaned or not.</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br>The GET argument value.<br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="post" id="_post">

		<td class="attributes"><code>
			 public 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_post">#</a>
		<code><a href="source-class-REST_Controller.html#789" title="Go to source code">post</a>( <span>string <var>$key</var> = <span class="php-keyword1">NULL</span></span>, <span>boolean <var>$xss_clean</var> = <span class="php-keyword1">TRUE</span></span> )</code>

		<div class="description short">
			
<p>Retrieve a value from the POST request arguments.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Retrieve a value from the POST request arguments.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$key</var></dt>
					<dd><code>string</code><br> The key for the POST request argument to retrieve</dd>
					<dt><var>$xss_clean</var></dt>
					<dd><code>boolean</code><br> Whether the value should be XSS cleaned or not.</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br>The POST argument value.<br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="put" id="_put">

		<td class="attributes"><code>
			 public 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_put">#</a>
		<code><a href="source-class-REST_Controller.html#806" title="Go to source code">put</a>( <span>string <var>$key</var> = <span class="php-keyword1">NULL</span></span>, <span>boolean <var>$xss_clean</var> = <span class="php-keyword1">TRUE</span></span> )</code>

		<div class="description short">
			
<p>Retrieve a value from the PUT request arguments.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Retrieve a value from the PUT request arguments.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$key</var></dt>
					<dd><code>string</code><br> The key for the PUT request argument to retrieve</dd>
					<dt><var>$xss_clean</var></dt>
					<dd><code>boolean</code><br> Whether the value should be XSS cleaned or not.</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br>The PUT argument value.<br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="delete" id="_delete">

		<td class="attributes"><code>
			 public 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_delete">#</a>
		<code><a href="source-class-REST_Controller.html#823" title="Go to source code">delete</a>( <span>string <var>$key</var> = <span class="php-keyword1">NULL</span></span>, <span>boolean <var>$xss_clean</var> = <span class="php-keyword1">TRUE</span></span> )</code>

		<div class="description short">
			
<p>Retrieve a value from the DELETE request arguments.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Retrieve a value from the DELETE request arguments.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$key</var></dt>
					<dd><code>string</code><br> The key for the DELETE request argument to retrieve</dd>
					<dt><var>$xss_clean</var></dt>
					<dd><code>boolean</code><br> Whether the value should be XSS cleaned or not.</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br>The DELETE argument value.<br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="_xss_clean" id="__xss_clean">

		<td class="attributes"><code>
			 protected 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__xss_clean">#</a>
		<code><a href="source-class-REST_Controller.html#840" title="Go to source code">_xss_clean</a>( <span>string <var>$val</var></span>, <span>boolean <var>$process</var></span> )</code>

		<div class="description short">
			
<p>Process to protect from XSS attacks.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Process to protect from XSS attacks.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$val</var></dt>
					<dd><code>string</code><br> The input.</dd>
					<dt><var>$process</var></dt>
					<dd><code>boolean</code><br> Do clean or note the input.</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="validation_errors" id="_validation_errors">

		<td class="attributes"><code>
			 public 
			array
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_validation_errors">#</a>
		<code><a href="source-class-REST_Controller.html#857" title="Go to source code">validation_errors</a>( )</code>

		<div class="description short">
			
<p>Retrieve the validation errors.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Retrieve the validation errors.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>array</code><br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="_check_login" id="__check_login">

		<td class="attributes"><code>
			 protected 
			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__check_login">#</a>
		<code><a href="source-class-REST_Controller.html#871" title="Go to source code">_check_login</a>( <span>string <var>$username</var> = <span class="php-quote">''</span></span>, <span>string <var>$password</var> = <span class="php-keyword1">NULL</span></span> )</code>

		<div class="description short">
			
<p>Check if the user is logged in.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Check if the user is logged in.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$username</var></dt>
					<dd><code>string</code><br> The user's name</dd>
					<dt><var>$password</var></dt>
					<dd><code>string</code><br> The user's password</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>boolean</code><br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="_prepare_basic_auth" id="__prepare_basic_auth">

		<td class="attributes"><code>
			 protected 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__prepare_basic_auth">#</a>
		<code><a href="source-class-REST_Controller.html#901" title="Go to source code">_prepare_basic_auth</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			






		</div>
		</div></td>
	</tr>
	<tr data-order="_prepare_digest_auth" id="__prepare_digest_auth">

		<td class="attributes"><code>
			 protected 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__prepare_digest_auth">#</a>
		<code><a href="source-class-REST_Controller.html#937" title="Go to source code">_prepare_digest_auth</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			






		</div>
		</div></td>
	</tr>
	<tr data-order="_check_whitelist_auth" id="__check_whitelist_auth">

		<td class="attributes"><code>
			 protected 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__check_whitelist_auth">#</a>
		<code><a href="source-class-REST_Controller.html#996" title="Go to source code">_check_whitelist_auth</a>( )</code>

		<div class="description short">
			
<p>Check if the client's ip is in the 'rest_ip_whitelist' config</p>

		</div>

		<div class="description detailed hidden">
			
<p>Check if the client's ip is in the 'rest_ip_whitelist' config</p>







		</div>
		</div></td>
	</tr>
	<tr data-order="_force_login" id="__force_login">

		<td class="attributes"><code>
			 protected 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__force_login">#</a>
		<code><a href="source-class-REST_Controller.html#1016" title="Go to source code">_force_login</a>( <span>string <var>$nonce</var> = <span class="php-quote">''</span></span> )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$nonce</var></dt>
					<dd><code>string</code></dd>
				</dl></div>




		</div>
		</div></td>
	</tr>
	<tr data-order="_force_loopable" id="__force_loopable">

		<td class="attributes"><code>
			 protected 
			array
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__force_loopable">#</a>
		<code><a href="source-class-REST_Controller.html#1035" title="Go to source code">_force_loopable</a>( <span>object|array <var>$data</var></span> )</code>

		<div class="description short">
			
<p>Force it into an array</p>

		</div>

		<div class="description detailed hidden">
			
<p>Force it into an array</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$data</var></dt>
					<dd><code>object|array</code></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>array</code><br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="_format_jsonp" id="__format_jsonp">

		<td class="attributes"><code>
			 protected 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__format_jsonp">#</a>
		<code><a href="source-class-REST_Controller.html#1055" title="Go to source code">_format_jsonp</a>( <span>array <var>$data</var> = <span class="php-keyword1">array</span>()</span> )</code>

		<div class="description short">
			
<p>Encode as JSONP</p>

		</div>

		<div class="description detailed hidden">
			
<p>Encode as JSONP</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$data</var></dt>
					<dd><code>array</code><br> The input data.</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br>The JSONP data string (loadable from Javascript).<br />
				</div>



		</div>
		</div></td>
	</tr>
	</table>







	<table class="summary" id="properties">
	<caption>Properties summary</caption>
	<tr data-order="rest_format" id="$rest_format">

		<td class="attributes"><code>
			protected 
			string|null
		</code></td>

		<td class="name">
				<a href="source-class-REST_Controller.html#18" title="Go to source code"><var>$rest_format</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">NULL</span></code></td>
		<td class="description"><div>
			<a href="#$rest_format" class="anchor">#</a>

			<div class="description short">
				
<p>This defines the rest format.</p>

			</div>

			<div class="description detailed hidden">
				
<p>This defines the rest format.</p>

<p>Must be overriden it in a controller so that it is set.</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="methods" id="$methods">

		<td class="attributes"><code>
			protected 
			array
		</code></td>

		<td class="name">
				<a href="source-class-REST_Controller.html#27" title="Go to source code"><var>$methods</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
		<td class="description"><div>
			<a href="#$methods" class="anchor">#</a>

			<div class="description short">
				
<p>Defines the list of method properties such as limit, log and level</p>

			</div>

			<div class="description detailed hidden">
				
<p>Defines the list of method properties such as limit, log and level</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="request" id="$request">

		<td class="attributes"><code>
			protected 
			object
		</code></td>

		<td class="name">
				<a href="source-class-REST_Controller.html#34" title="Go to source code"><var>$request</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">NULL</span></code></td>
		<td class="description"><div>
			<a href="#$request" class="anchor">#</a>

			<div class="description short">
				
<p>General request data and information. Stores accept, language, body, headers,
etc.</p>

			</div>

			<div class="description detailed hidden">
				
<p>General request data and information. Stores accept, language, body, headers,
etc.</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="response" id="$response">

		<td class="attributes"><code>
			protected 
			object
		</code></td>

		<td class="name">
				<a href="source-class-REST_Controller.html#42" title="Go to source code"><var>$response</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">NULL</span></code></td>
		<td class="description"><div>
			<a href="#$response" class="anchor">#</a>

			<div class="description short">
				
<p>What is gonna happen in output?</p>

			</div>

			<div class="description detailed hidden">
				
<p>What is gonna happen in output?</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="rest" id="$rest">

		<td class="attributes"><code>
			protected 
			object
		</code></td>

		<td class="name">
				<a href="source-class-REST_Controller.html#49" title="Go to source code"><var>$rest</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">NULL</span></code></td>
		<td class="description"><div>
			<a href="#$rest" class="anchor">#</a>

			<div class="description short">
				
<p>Stores DB, keys, key level, etc</p>

			</div>

			<div class="description detailed hidden">
				
<p>Stores DB, keys, key level, etc</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="_get_args" id="$_get_args">

		<td class="attributes"><code>
			protected 
			array
		</code></td>

		<td class="name">
				<a href="source-class-REST_Controller.html#56" title="Go to source code"><var>$_get_args</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
		<td class="description"><div>
			<a href="#$_get_args" class="anchor">#</a>

			<div class="description short">
				
<p>The arguments for the GET request method</p>

			</div>

			<div class="description detailed hidden">
				
<p>The arguments for the GET request method</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="_post_args" id="$_post_args">

		<td class="attributes"><code>
			protected 
			array
		</code></td>

		<td class="name">
				<a href="source-class-REST_Controller.html#63" title="Go to source code"><var>$_post_args</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
		<td class="description"><div>
			<a href="#$_post_args" class="anchor">#</a>

			<div class="description short">
				
<p>The arguments for the POST request method</p>

			</div>

			<div class="description detailed hidden">
				
<p>The arguments for the POST request method</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="_put_args" id="$_put_args">

		<td class="attributes"><code>
			protected 
			array
		</code></td>

		<td class="name">
				<a href="source-class-REST_Controller.html#70" title="Go to source code"><var>$_put_args</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
		<td class="description"><div>
			<a href="#$_put_args" class="anchor">#</a>

			<div class="description short">
				
<p>The arguments for the PUT request method</p>

			</div>

			<div class="description detailed hidden">
				
<p>The arguments for the PUT request method</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="_delete_args" id="$_delete_args">

		<td class="attributes"><code>
			protected 
			array
		</code></td>

		<td class="name">
				<a href="source-class-REST_Controller.html#77" title="Go to source code"><var>$_delete_args</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
		<td class="description"><div>
			<a href="#$_delete_args" class="anchor">#</a>

			<div class="description short">
				
<p>The arguments for the DELETE request method</p>

			</div>

			<div class="description detailed hidden">
				
<p>The arguments for the DELETE request method</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="_args" id="$_args">

		<td class="attributes"><code>
			protected 
			array
		</code></td>

		<td class="name">
				<a href="source-class-REST_Controller.html#84" title="Go to source code"><var>$_args</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
		<td class="description"><div>
			<a href="#$_args" class="anchor">#</a>

			<div class="description short">
				
<p>The arguments from GET, POST, PUT, DELETE request methods combined.</p>

			</div>

			<div class="description detailed hidden">
				
<p>The arguments from GET, POST, PUT, DELETE request methods combined.</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="_allow" id="$_allow">

		<td class="attributes"><code>
			protected 
			boolean
		</code></td>

		<td class="name">
				<a href="source-class-REST_Controller.html#91" title="Go to source code"><var>$_allow</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">TRUE</span></code></td>
		<td class="description"><div>
			<a href="#$_allow" class="anchor">#</a>

			<div class="description short">
				
<p>If the request is allowed based on the API key provided.</p>

			</div>

			<div class="description detailed hidden">
				
<p>If the request is allowed based on the API key provided.</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="_zlib_oc" id="$_zlib_oc">

		<td class="attributes"><code>
			protected 
			boolean
		</code></td>

		<td class="name">
				<a href="source-class-REST_Controller.html#98" title="Go to source code"><var>$_zlib_oc</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">FALSE</span></code></td>
		<td class="description"><div>
			<a href="#$_zlib_oc" class="anchor">#</a>

			<div class="description short">
				
<p>Determines if output compression is enabled</p>

			</div>

			<div class="description detailed hidden">
				
<p>Determines if output compression is enabled</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="_supported_formats" id="$_supported_formats">

		<td class="attributes"><code>
			protected 
			array
		</code></td>

		<td class="name">
				<a href="source-class-REST_Controller.html#105" title="Go to source code"><var>$_supported_formats</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>(
	<span class="php-quote">'xml'</span> =&gt; <span class="php-quote">'application/xml'</span>,
	<span class="php-quote">'json'</span> =&gt; <span class="php-quote">'application/json'</span>,
	<span class="php-quote">'jsonp'</span> =&gt; <span class="php-quote">'application/javascript'</span>,
	<span class="php-quote">'serialized'</span> =&gt; <span class="php-quote">'application/vnd.php.serialized'</span>,
	<span class="php-quote">'php'</span> =&gt; <span class="php-quote">'text/plain'</span>,
	<span class="php-quote">'html'</span> =&gt; <span class="php-quote">'text/html'</span>,
	<span class="php-quote">'csv'</span> =&gt; <span class="php-quote">'application/csv'</span>
)</code></td>
		<td class="description"><div>
			<a href="#$_supported_formats" class="anchor">#</a>

			<div class="description short">
				
<p>List all supported methods, the first will be the default format</p>

			</div>

			<div class="description detailed hidden">
				
<p>List all supported methods, the first will be the default format</p>


			</div>
		</div></td>
	</tr>
	</table>



</div>

	<div id="footer">
		 API documentation generated by <a href="http://apigen.org">ApiGen 2.6.1</a>
	</div>
</div>
</div>
</body>
</html>
